home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d26 / tutsim.arc / TUTSIM.HLP < prev    next >
Encoding:
Internet Message Format  |  1989-02-20  |  14.9 KB

  1. From: keithe@tekgvs.LABS.TEK.COM (Keith Ericson)
  2. Newsgroups: comp.binaries.ibm.pc.d
  3. Subject: updated help file for tutsim
  4. Date: 21 Feb 89 03:07:17 GMT
  5.  
  6. Since submitting TUTSIM to Rahul I've improved the help file document.
  7. Once again - don't blame Applied i for any misteaks in this file: thay
  8. didn't create it and aren't responsible for it (or them, depending on
  9. how it all works out). -  kde
  10.  
  11. Begin TUTSIM.HLP, Second Version:
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.             T U T S I M   System Simulator
  21.  
  22.  
  23.  
  24.  
  25. TUTSIM is "a program for Engineering Design and Optimization by Simulation of
  26. continuous dynamic systems"  created by the TWENTE UNIVERSITY of TECHNOLOGY,
  27. Enschede, The Netherlands.  Copyright 1982, 1983 by the North American
  28. Distributor, APPLIED i.  "TUTSIM" is a trademark of APPLIED I.  The following
  29. message is printed on the distribution diskette label:
  30.  
  31.     TUTSIM  IBM PC  DEMONSTRATION DISK
  32.     Dynamic System Design Tool, By Simulation
  33.     Copyright 1982, 1983 by APPLIED i.
  34.     All Resale Rights reserved.  Permission is granted to copy the
  35.     ENTIRE contents of this disk for distribution by non-profit clubs
  36.     or non-profit private exchange.  Please mark "Copyright APPLIED i".
  37.     Duplication of parts or individual files is prohibited.
  38.  
  39. As of the time of this release (approx. 1983) APPLIED i provided TUTSIM for in
  40. IBM-PC, CP/M and APPLE formats.  TUTSIM requires 64k bytes of RAM, DOS Version
  41. 1.1 or later, CGA (or better) display, and EPSON with Graphtrax for hardcopy.
  42.  
  43. APPLIED i is listed on the diskette envelope as
  44.  
  45.     APPLIED i
  46.     200 California Ave., Suite 214
  47.     Palo Alto CA  94306
  48.     (415) 325 4800
  49.  
  50. Current status of APPLIED i is not known to me.  I am not now nor have I ever
  51. been associated with APPLIED i except as an intrigued user of the TUTSIM demo
  52. system.
  53.  
  54. The following is merely a summary to use as a guide  in using TUTSIM, not a
  55. program specification.  Any errors, don't blame Applied i: they didn't generate
  56. this documentation.
  57.  
  58. Various trademarks apply,     Keith Ericson        Standard disclaimers apply,
  59. You know what they are.       February, 1989        We all know what they are.
  60.  
  61.  
  62.  
  63.  
  64. TUTSIM Command Summary
  65.  
  66. CS -    Change Model Structure
  67. CP -    Change Model Parameters
  68. CB -    Change Output Blocks and Ranges
  69. CT -    Change Timing Data
  70.  
  71. SD -    Start Simulations, graphical output to Display
  72. SN -    Start Simulations, numerical output to Display
  73. SNP -    Start Simulations, numerical output to Printer
  74. SP -    Start Simulations, print-plot output to Display
  75. SPP -    Start Simulations, print-plot output to Printer
  76.  
  77. PD -    Proceed, output like SD
  78. PN -    Proceed, output like SN
  79. PNP -    Proceed, output like SNP
  80. PP -    Proceed, output like SD
  81. PPP -    Proceed, output like SPP
  82.  
  83.     The output interval may be specified following an S or a P command as
  84.     in SD:10 which will provide one output point for each 10 calculations
  85.  
  86. L -    List model data to display
  87. LP -    List model data to printer
  88. TT -    Type timing data to display
  89. TB -    Type output blocks and ranges
  90. V -    Show last calculated value of a block to be specified
  91. VP -    Like V, but output to the printer
  92. CL -    Clear the graphics screen
  93. GD -    Draw a grid on the graphics screen
  94. MG -    Switch to graphics screen (return with <CR>)
  95. HC -    Print a hardcopy of the graphics screen
  96. DF -    Save a copy of the simulation model in a file
  97. I -     Replace initial conditions of history blocks by outputs
  98. A -     Abort TUTSIM and return to DOS
  99. H -     Print the HELP message
  100. E -     Restart
  101.  
  102. TUTSIM FUNCTION BLOCK
  103. ~~~~~~ ~~~~~~~~ ~~~~~
  104. Tutsim models are built of interconnected function blocks.  A "GENERIC" function
  105. block would assume the following form:
  106.  
  107.  
  108.                |   Parameters
  109.                |   param1, param2,..,paramN
  110.                V
  111. INPUTS:        +-----------------------+
  112.    i1    ------->|            |
  113.    i2    ------->|    GENERIC        |
  114.        .    |            +------> Output, U(t)
  115.        .    |            |
  116.    iN    ------->|            |
  117.         +-----------------------+
  118.  
  119. Source functions blocks (CON (constant), NOI (noise), PLS (pulse)) and the TIM
  120. (time) blocks take no inputs.  Most of the other function blocks require at
  121. least one input.
  122.  
  123. Not all function blocks require parameters.  Parameters are entered during
  124. "Parameter Entry" or "Parameter Change" operations; unspecified parameters
  125. default to zero in almost all cases.
  126.  
  127.  
  128.  
  129. ENTERING THE MODEL
  130. ~~~~~~~~ ~~~ ~~~~~
  131. Model entry from the keyboard is initiated by responding with a "K" to the
  132. initial "INPUT FROM?" query (or after giving the "E" command).  A Model consists
  133. of an interconnected system of function blocks (the "structure"), the function
  134. block parameter specifications, output block and timing specifications.  You
  135. will be prompted for each of these functions in that order in what is known as
  136. the "Console Model Entry Dialog."
  137.  
  138. STRUCTURE ENTRY
  139. ~~~~~~~~~ ~~~~~
  140. You are first prompted for the Structure of the Model, specifying the blocks
  141. used and their interconnection(s).
  142.  
  143. The format is
  144.  
  145.     BlockNumber, BlockName, InputBlocksList
  146.  
  147. BlockNumber is a user-specified number (integer) assigned the function block
  148. being added to the model. Note: Block 0 (zero) is reserved and unavailable for
  149. user specification.  It is the simulation timing information.
  150.  
  151. BlockName specifies the current block as one of the Tutsim function blocks.
  152. (See summary/description, below.)
  153.  
  154. InputBlocksList is a comma-separated list of block numbers whose outputs
  155. comprise this block's inputs.  With most blocks the inputs are summed to provide
  156. the block's input value; a negative block number serves to negate (that is, it
  157. inverts, or multiplies by -1) the output from that block prior to the input
  158. summation.
  159.  
  160. Blocks are deleted by entering
  161.  
  162.     BlockNumber,D
  163.  
  164. Blocks are replaced by entering a new block specification for an existing
  165. BlockNumber.
  166.  
  167. Structure entry is terminated with a <CR>-only line.
  168.  
  169. MODEL PARAMETERS
  170. ~~~~~ ~~~~~~~~~~
  171. After entering the structure you're prompted for the parameters of each the
  172. function blocks.  The format is
  173.  
  174.     BlockNumber, ParameterList
  175.  
  176. ParameterList is a comma-separated list of values to be assigned to the
  177. respective parameters of block BlockNumber.  To review the parameters for a
  178. given block enter just the BlockNumber and no paramters.
  179.  
  180. Undefined parameter values assume a value of zero (0). This is usually not a
  181. problem, but in the case of ATT (attenuators) the result will be a division by
  182. zero, not a "good thing."
  183.  
  184. When entering or changing parameters the current block parameters can be
  185. reviewed by entering the BlockNumber (only) followed by a <CR>.
  186.  
  187. Parameter entry is terminated with a <CR>-only line.
  188.  
  189.  
  190.  
  191. PLOT BLOCK AND RANGES
  192. ~~~~ ~~~~~ ~~~ ~~~~~~
  193. Following parameter entry you'll be prompted for the Plotblocks and Range
  194. Information, specifying which block outputs are to be plotted and the scale
  195. factor for each.  Tutsim prompts for the X-axis (usually the time axis)
  196. beginning and ending points and also prompts for as many as four (4) Y-axis
  197. outputs per run.  Block 0 is an implied output reserved for the time scale;
  198. assign its output to X1 and provide the t-min and t-max parameters to specify
  199. the time-axis beginning and ending values.  (The display can be saved and
  200. "overdrawn" on subsequent runs, if desired; but there are only four colors
  201. available.)
  202.  
  203. The format for specifying a plot block and range is
  204.  
  205.     BlockNumber,PlotMinimum,PlotMaximum
  206.  
  207. When changing plot blocks and ranges you can review the current specifications
  208. by entering <CR> to the first prompt.  Thereafter, entering <CR> will retain the
  209. previous plot block values.  Delete a plot block specification by entering "D"
  210. in response to the prompt.
  211.  
  212. A PLOTBLOCK specification dialog might look like this (first two columns, below,
  213. only. Column 3 is not actually typed in):
  214.  
  215. TUTSIM           USER
  216. PROMPT---+   +-RESPONSE-+              +---------DESCRIPTION--------------+
  217.          |   |          |              |                                  |
  218.          V   V          V              V                                  V
  219.  
  220.     X1:  0,0,200 <CR>              The X-axis is Block 0, the timing
  221.                            information of the simulation
  222.  
  223.     Y1:  1,-1.,9.<CR>              The output of Block 1 is plotted and
  224.                                        scaled from -1 to 9 on the Y-axis
  225.  
  226.     Y2:  3,-1.,1.<CR>              The output of Block 3 is plotted, scaled
  227.                                        from -1 to 1 on the y-axis
  228.  
  229.     Y3:  4,0,20<CR>                The output of Block 4 is plotted, scaled
  230.                                        from 0 to 20 on the y-axis
  231.  
  232.     Y4:  <CR>                      the PLOTBLOCKS dialog is terminated
  233.  
  234.  
  235. TIMING INFORMATION
  236. ~~~~~~ ~~~~~~~~~~~
  237. Finally, you're prompted for the Timing Information to specify the stepsize and
  238. total simulation time.  Format is
  239.  
  240.     Delta,FinalTime
  241.  
  242. The ratio of FinalTime/Delta determines the number of calculations. Too small of
  243. a ratio can lead to instability in the computations due to inexact integrations:
  244. a reasonable ratio is 500.  Then try doubling the ratio until successive runs
  245. show no differences greater than an acceptable limit.
  246.  
  247. When changing the timing information, review the current values by entering
  248. <CR>; you must enter a pair of values to terminate the timing information input
  249. (type in the old ones to retain them).
  250.  
  251.  
  252.  
  253. RUNNING THE SIMULATION
  254. ~~~~~~~ ~~~ ~~~~~~~~~~
  255. When the model structure, function block parameters, plot information and timing
  256. information have all been entered TUTSIM returns to command mode.  You can now
  257. run the simulation, save the model description (to disk file), or modify the
  258. model structure, function block parameters, plotblock specifications or timing
  259. information.  (A summary of commands is available by entering "H <CR>.")
  260.  
  261. The simulation is initiated with one of the "S" commands (see the command
  262. summary at the beginning of this document for the variations). The simulation
  263. run can be interrupted (strike the spacebar) and returned to command mode.  You
  264. can then change the model structure ("CS"), change parameters ("CP"), change the
  265. output blocks ("CB") or change the timing specifications ("CT").  Specific
  266. information or numerical values can be printed if desired (the "L", "T" and "V"
  267. commands).  Finally, the run be continued with one of the "P" commands.
  268.  
  269. The graphics screen can be cleared with "CL"; a grid can be plotted on the
  270. graphics screen with "GD"; the graphics screen displayed  with "MG" (return to
  271. terminal mode with a <CR>); or the graphics screen printed to the printer with
  272. "HC" (hardcopy).
  273.  
  274. The current Model specification (structure, parameters, etc) can be saved to as
  275. disk file with the "DF" command.  You'll be prompted for a file name to be
  276. written on the current drive/(sub)directory.
  277.  
  278. STARTING OVER
  279. ~~~~~~~~ ~~~~
  280. From command mode "E" will erase the current model and allow entry of a new one,
  281. either from a disk file or from the keyboard.
  282.  
  283. TERMINATING TUTSIM
  284. ~~~~~~~~~~~ ~~~~~~
  285. From command mode "A" will abort TUTSIM and return to DOS.
  286.  
  287.  
  288.  
  289. FUNCTION BLOCKS AVAILABLE IN TUTSIM
  290. ~~~~~~~~ ~~~~~~ ~~~~~~~~~ ~~ ~~~~~~
  291. The available Blocks are listed below, along with the number of inputs, number
  292. of parameters, and a short description.
  293.  
  294.     For logical functions,    input values > 0 are TRUE
  295.                 input values <=0 are FALSE
  296.                 output TRUE = 1
  297.                 output FALSE = 0
  298.  
  299.     Note: "SOI" means "Sum Of (all) Inputs
  300. ===============================================================================
  301. Name    Number
  302. of      of
  303. Block    Inputs    Parameter    Function
  304. ------------------------------------------------------------------------------ 
  305. ABS    1-40    none        Absolute value of SOI
  306. AND    2-40    none        Logical AND of inputs
  307. ATT    1-40    A        Attenuator: U(t)=SOI/A
  308. FIX    1-40    none        Truncated Integer value of SOI
  309. ORR    2-40    none        Logical inclusive-OR of inputs
  310. ADL    1-40    Ic        Algebraic delay unit; Ic is the initial
  311.                 condition:
  312.                 U(0)=Ic      U(t)=SOI, t>0
  313. CON    none    C        Constant; C is the output value
  314. COS     1-40    none        Cosine of SOI
  315. SIN     1-40    none        Sine of SOI
  316. DEL     1-40    N,Td,Ic        Delay function
  317.                 N=number of previous values stored;
  318.                 Td=time delay; Ic=Initial condition
  319.                 U(t)=Ic,        0<=t<Td
  320.                     =SOI(t-Td), t>=Td
  321. DIV    2    none        Divide; output is I1/I2
  322. EUL    1-40    Ic        Integrator, using Euler integration
  323. EXP    1-40    none        Exponentiation; output is e to the SOI power
  324. FIO    1-40    K,T,Ic        First Order Function Block; output is
  325.                 the solution to the equation
  326.                 U(s)=K*(1/(1+sT))*SOI(s)
  327.  
  328.     The pole-zero plot of the FIO transfer function is
  329.  
  330.                 | jOmega
  331.                 |
  332.                 |
  333.         ------X---------+----------- s->
  334.               |<---T--->|
  335.                 |
  336.                 |
  337.  
  338. FNC    1-40    variable,    Function block: arbitrary piecewise-linear
  339.         2-100 pairs    function described by (x,y) pairs with
  340.                 x(i) <= x(i+1); the number of (x,y) pairs
  341.                 is specified as the last value on the
  342.                 structure input line; U(t)=F(SOI)
  343. FND    1-40    P        Replicate an FNC block output; P is the
  344.                 original FNC block number
  345. GAI    1-40    G        Gain block: U(t)=G*SOI
  346. GSQ    1-40    P        Square conductance:
  347.                 U=sign(SOI)*ABS(SOI/P)^.5;
  348.                 (useful primarily in hydraulics)
  349.  
  350.  
  351.  
  352. FUNCTION BLOCKS AVAILABLE IN TUTSIM, Continues
  353. ===============================================================================
  354. Name    Number
  355. of      of
  356. Block    Inputs    Parameter    Function
  357. ------------------------------------------------------------------------------ 
  358. INT    1-40    Ic        Integrator, using Adams-Bashworth
  359.                 second-order integration
  360. LIM    1-40    Min,Max        Limiter; output is SOI restricted
  361.                 to the range (Min..Max), inclusive
  362. LMI    1-40    Ic,Min,Max    INT function with Min..Max limiting
  363. LME    1-40    Ic,Min,Max    EUL function with Min..Max limiting
  364. LOG    1-40    none        natural logarithm of SOI
  365.                 (unrecoverable error if SOI <= 0)
  366. MAX    1-40    none        output is the maximum of input values
  367. MIN    1-40    none        output is the minimum of input values
  368. MUL    2-40    none        Multiply; output is product of inputs
  369. NOI    none    none        Noise; output is a uniformly distributed
  370.                 pseudo random variable in the range
  371.                 (-1..+1), inclusive
  372. PID    1-40    K,Ti,Td,a    Proportional Derivative controller;
  373.         Ici,Icd        U(t) is the solution to the transfer
  374.                 function
  375.  
  376.     U(s)/SOI(s)=K[(1/(sTi))+(1+sTd/(1+saTd)], Ti>Td, a<1
  377.  
  378.                 This block is for use by the experienced modeler
  379. PLS    none    T1,T2,P        Pulse generator;
  380.                 U(t)=P for T1<=t<=T2
  381.                      0 otherwise
  382. PWR    1-40    P        Power; output=SOI^P; SIO must be >=0;
  383.                 use MUL for integer P (faster)
  384. REL    4    P        Relational operator; selects inputs I1,
  385.                 I2 or I3 by comparing I4 with P:
  386.                     U=I1 if I4>P
  387.                     U=I2 if I4=P
  388.                     U=I3 if I4<P
  389.                 Equality is a floating point test; enter
  390.                 P as integer and use FIX on I4 to allow
  391.                 a range of floating point values to test
  392.                 as equal.
  393. RSQ    1-40    P        Square resistance: U=P*SOI*ABS(SOI);
  394.                 (primarily useful in hydraulics)
  395. SPL    1-40    P        Sample and hold; P is the sampling
  396.                 interval (and should be >0):
  397.                 U(t)=SOI for t=nP, n integer
  398.                     =U(t-1) otherwise
  399. SQT    1-40    none        Square root; output= SOI^.5
  400. SUM    1-40    none        Summation; output is SOI
  401. ================================================================================
  402.         End of Documentation - Description of Tutsim Simulator
  403.